home *** CD-ROM | disk | FTP | other *** search
/ PCMania 30 / PCMania CD30.iso / sharewar / util / iohelps / tutorial.doc < prev    next >
Encoding:
Text File  |  1995-01-25  |  14.3 KB  |  440 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                TUTORIAL
  7.  
  8.  
  9.                              ioHelps 1.1
  10.  
  11.  
  12.                     Programa generador de sistemas
  13.                   de ayuda interactiva para Windows
  14.  
  15.  
  16.                            (c) Iñaki Otero
  17.                     Todos los derechos reservados
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                               * * * * *
  24.  
  25.  
  26.  
  27.     
  28.     Pasos a seguir para construir una ayuda:
  29.  
  30.  
  31.      1.- ¿Por qué este tutorial?.
  32.  
  33.      2.- Crear un nuevo proyecto.
  34.  
  35.      3.- Crear el índice general de la ayuda.
  36.  
  37.      4.- Añadir fichas al índice.
  38.  
  39.      5.- Añadir fichas de texto como popups.
  40.  
  41.      6.- Llamadas a un popup independiente.
  42.  
  43.      7.- Reordenar un menú.
  44.  
  45.      8.- Finalizar un proyecto de ayuda.
  46.  
  47.  
  48.                               * * * * *
  49.  
  50.  
  51.     1.- ¿Por qué este tutorial?.
  52.  
  53.     Pues por aquello que se decía hablando del sexo, de que "la teoría
  54.     sin la práctica tiene poco futuro".
  55.  
  56.     Como al principio puede parecer un poco enredoso el trabajo con
  57.     ioHelps, con este tutorial vamos a descubrir lo sencillo que es
  58.     generar una ayuda.
  59.  
  60.     Paso a paso, y punto por punto, vamos a ir analizando el proceso
  61.     de creación de la ayuda y comprobando la mayor parte de las
  62.     posibilidades de programa.
  63.  
  64.     Cada vez que terminemos un punto, deberemos salvar el proyecto en
  65.     curso, generar los ficheros y compilarlos, con lo cual, iremos
  66.     viendo inmediatamente el efecto que producimos cada vez que
  67.     añadimos algo nuevo.
  68.  
  69.     Este método nos facilitará enormemente la detección de los
  70.     posibles errores.
  71.  
  72.     Espero que os sea de utilidad.
  73.  
  74.  
  75.  
  76.     2.- Crear un nuevo proyecto.
  77.     
  78.     Vamos a crear un sistema de ayuda denominado "Nuestros Vinos", en
  79.     el cual vamos a ir desglosando distintos matices de ellos.
  80.  
  81.     Recordad que esto no es un tratado enológico, sino un simple
  82.     ejercicio tutorial para crear un sistema de ayuda. Aquí lo
  83.     importante es el continente, no el contenido.
  84.  
  85.     Para crear un nuevo proyecto, lo primero es pulsar sobre el icono
  86.     correspondiente (también podemos elegir la opción Nuevo proyecto
  87.     del Menú de Proyectos).
  88.  
  89.     En el campo Nombre del proyecto, teclearemos "Nuestros Vinos".
  90.  
  91.     En el campo Cabecera actual del proyecto, introducimos "Los
  92.     mejores del mundo y parte del extranjero".
  93.  
  94.     Finalmente, pulsamos sobre el botón Aceptar.
  95.  
  96.     El índice principal de nuestro proyecto, siguiendo una buena
  97.     costumbre, lo vamos a iniciar con una FICHA FALSA que, al
  98.     finalizar el proyecto, borraremos, pero que de momento nos puede
  99.     ser útil.
  100.  
  101.     Así que elegimos la opción Menú, de la ventana Tipo de Ficha.
  102.  
  103.     En el campo Nombre del Menú actual, tecleamos "Falsa".
  104.  
  105.     Dejamos en blanco la Cabecera del menú y pulsamos sobre el botón
  106.     Aceptar.
  107.  
  108.     Nos saldrá la Ventana del proyecto, y en ella ya tendremos dos
  109.     registros:
  110.  
  111.     Nuestros Vinos, Nivel 0, ID 1000.
  112.     Falsa, Nivel 1, ID 1020.
  113.  
  114.     Procedemos a salvar el proyecto con el nombre Vinos2, generamos
  115.     los ficheros, salimos de ioHelps y compilamos el proyecto de
  116.     ayuda.
  117.  
  118.  
  119.  
  120.     3.- Crear el índice general de la ayuda.
  121.     
  122.     Una vez creado el proyecto, vamos crear el índice general de la
  123.     ayuda. Este va a estar compuesto por cuatro índices:
  124.  
  125.     - Vinos tintos, índice menú ya que de él nacerán más fichas.
  126.  
  127.     - Vinos rosados, índice texto, ya que vamos a introducir texto
  128.     directamente.
  129.  
  130.     - Vinos blancos, índice menú ya que de él saldrán más fichas.
  131.  
  132.     - La foto del vino, índice bitmap, ya que en él vamos a introducir
  133.     un gráfico.
  134.  
  135.     Vayamos paso a paso:
  136.  
  137.     Lo primero, recordar que estamos trabajando con ioHelps 1.1, por
  138.     lo tanto no podremos incluir caracteres típicos de nuestro idioma
  139.     (como acentos, eñes, etc.) dado que el programa no los admite y
  140.     produciremos errores a la hora de compilar el proyecto de ayuda.
  141.  
  142.     - Pulsamos sobre el botón Indice Menú
  143.     En el campo Menú actual introducimos "Vinos tintos".
  144.     En el campo Cabecera del menú actual tecleamos "Los más recios".
  145.     Pulsamos sobre el botón Aceptar.
  146.  
  147.     - Pulsamos sobre el botón Indice Texto.
  148.     En el campo Ficha actual, tecleamos "Vinos rosados".
  149.     En el campo Cabecera actual introducimos "Exquisita unión".
  150.     En el campo Texto escribimos "No hay nada como un rosado fresquito
  151.     para levantar el apetito".                                 
  152.     Pulsamos TAB para salir de la ventana del hipertexto.
  153.     En el campo Tipo, seleccionamos Ventana.
  154.     Pulsamos sobre el botón Aceptar.
  155.  
  156.     - Pulsamos sobre el botón Indice Menú.
  157.     En el campo Menú actual, tecleamos "Vinos blancos".
  158.     En el campo Cabecera del menú actual, introducimos "Oro líquido".
  159.     Pulsamos sobre el botón Aceptar.
  160.  
  161.     - Pulsamos sobre el botón Indice Bitmap.
  162.     En el campo Ficha de Bitmap actual, tecleamos "La foto de los
  163.     vinos".
  164.     En el campo Cabecera de Bitmap actual, introducimos "Vaya birria
  165.     de foto".
  166.     En el campo Nombre del Bitmap, ponemos "Vino1".
  167.     En el campo Tipo seleccionamos Ventana.
  168.     Pulsamos el botón Aceptar.
  169.     
  170.     Si todo ha ido como debería de ir, en la Ventana del proyecto
  171.     deberían aparecer los siguientes registros:
  172.  
  173.     Nuestros Vinos, nivel 0, ID 1000.
  174.     Falsa, nivel 1, ID 1020.
  175.     Vinos tintos, nivel 1, ID 1040.
  176.     Vinos rosados, nivel 1, ID 1060.
  177.     Vinos blancos, nivel 1, ID 1080.
  178.     La foto de los vinos, nivel 1, ID 1100.
  179.  
  180.     Si no fuera así, deberíamos corregir el error.
  181.  
  182.     Si todo ha ido bien, procedemos a salvar el proyecto con el nombre
  183.     Vinos3, generamos los ficheros, salimos de ioHelps y compilamos el
  184.     proyecto de ayuda.
  185.     
  186.  
  187.  
  188.     4.- Añadir fichas al índice.
  189.     
  190.     Al Indice Menú Vinos Blancos le vamos a añadir tres fichas:
  191.  
  192.     - Manzanilla, como ficha de texto.
  193.     - Cavas, como ficha de menú.
  194.     - Penedés como ficha bitmap.
  195.  
  196.     Además vamos a hacer desde la ficha Manzanilla, una llamada a los
  197.     Vinos rosados, por lo tanto tomamos nota de que el número ID de
  198.     Vinos rosados es 1060.
  199.  
  200.     - Posicionamos el cursor sobre el registro Vinos Blancos.
  201.     Pulsamos sobre el botón Fichas texto.
  202.  
  203.     En la ventana que aparecerá, veremos:
  204.  
  205.     Ficha anterior: Vinos Blancos
  206.     Cabecera anterior: Oro líquido
  207.     Nivel 1 (como nivel de la ficha anterior)
  208.     Nivel 2 (como nivel de la ficha actual)
  209.     Número ID 1140
  210.     Los demás campos en blanco.
  211.  
  212.     Es una buena medida el comprobar siempre estos datos, así nos
  213.     aseguramos de que las herencias son correctas, es decir que
  214.     nuestra nueva ficha nace realmente de aquella que pretendíamos.
  215.  
  216.     Seguimos, en el campo Ficha actual ponemos Manzanilla.
  217.     En el campo Cabecera actual ponemos Blanca y suave.
  218.  
  219.     En el Texto escribimos "No sé que vino me gusta más como
  220.     aperitivo, si la Manzanilla de Sanlúcar o el /*/rosado**1060// de
  221.     Navarra".
  222.  
  223.     Pulsamos Tab para salir de la ventana de hipertexto.
  224.  
  225.     Lo que hemos hecho es una llamada desde la palabra rosado a la
  226.     ventana 1060, que era la de los Vinos rosados.
  227.     Se la llama de forma ventana, si hubieramos querido que la ventana
  228.     de los Vinos rosados se nos mostrara con la forma de una ventanita
  229.     PopUp, sólo deberíamos haber eliminado el asterisco que figura
  230.     entre las dos barras inclinadas.
  231.  
  232.     Elegimos Ventana en el campo Tipo.
  233.     Pulsamos sobre el botón Aceptar.
  234.  
  235.     - Nos posicionamos sobre Vinos blancos.
  236.     Pulsamos sobre Fichas Menú.
  237.     En el primer campo tecleamos "Cavas".
  238.     En el segundo ponemos "Burbujas de vida".
  239.     Pulsamos Aceptar.
  240.  
  241.     - Nos posicionamos sobre Vinos blancos.
  242.     Pulsamos sobre Ficha Bitmap.
  243.     Rellenamos el primer campo con "Penedés".
  244.     El segundo con "Magníficos blancos".
  245.     En el nombre del bitmap ponemos "vinos2".
  246.     Elegimos PopUp en el campo Tipo.
  247.     Pulsamos sobre Aceptar.
  248.  
  249.     Debajo del registro ATENCION deberían aparecer tres fichas con el
  250.     nivel 2:
  251.  
  252.     Manzanilla, ID 1140.
  253.     Cavas, ID 1160.
  254.     Penedés, ID 1180.
  255.  
  256.     Procedemos a salvar el proyecto con el nombre Vinos5, generamos
  257.     los ficheros, salimos de ioHelps y compilamos el proyecto de
  258.     ayuda.
  259.  
  260.  
  261.  
  262.     5.- Añadir fichas de texto como PopUps.
  263.  
  264.     A la ficha de Menú Cavas, le vamos añadir dos fichas de texto que
  265.     aparecerán como ventanas tipo PopUp: Brut y Semiseco.
  266.  
  267.     - Nos posicionamos sobre Cavas.
  268.     Pulsamos Fichas texto.
  269.     Rellenamos el primer campo con "Brut".
  270.     El segundo con "Cava muy seco".
  271.     Y el Texto con "Me encantan los cavas fuertes".
  272.     Pulsamos Tab para salir del hipertexto.
  273.     En el campo Tipo seleccionamos PopUp.
  274.     Pulsamos sobre Aceptar.
  275.  
  276.     - Nos posicionamos sobre Cavas.
  277.     Pulsamos Fichas texto.
  278.     Rellenamos el primer campo con "Semiseco".
  279.     El segundo con "Cava suave".
  280.     Y el Texto con "No hay nada que refresque más que un cava
  281.     semiseco".
  282.     Pulsamos Tab para salir del hipertexto.
  283.     Elegimos PopUp en el campo Tipo.
  284.     Pulsamos sobre Aceptar.
  285.  
  286.     En la ventana del proyecto deberían estar dos nuevas fichas con el
  287.     nivel 3:
  288.  
  289.     Brut, ID 1200.
  290.     Semiseco, ID 1220.
  291.  
  292.     Procedemos a salvar el proyecto con el nombre Vinos6, generamos
  293.     los ficheros, salimos de ioHelps y compilamos el proyecto de
  294.     ayuda.
  295.  
  296.  
  297.  
  298.     6.- Llamadas múltiples a una ventana.
  299.     
  300.     Para hacer una llamada desde dos sitios diferentes a una misma
  301.     ventana, vamos a crear dos Fichas de texto herederas de Vinos
  302.     tintos: Vinos de la Ribera del Duero  y  Vinos de Jumilla.
  303.  
  304.     Tomamos nota de que la ficha a la que vamos a llamar, la de nombre
  305.     "La foto de los vinos", tiene el número ID 1100.
  306.  
  307.     - Nos posicionamos sobre Vinos tintos.
  308.     Pulsamos sobre Fichas texto.
  309.     En el primer campo tecleamos "Vinos de la ribera del Duero".
  310.     En el segundo ponemos "Sin comentarios".
  311.     En el Texto escribimos "Vinos de la ribera, como el //Vega
  312.     Sicilia**1100//, o como el Pesquera".
  313.     Pulsamos Tab.
  314.     Seleccionamos Ventana en el campo Tipo.
  315.     Pulsamos sobre Aceptar.
  316.  
  317.     Hemos creado una Ficha de texto que contiene una llamada desde la
  318.     frase Vega Sicilia a la ventana "La foto de los vinos", y se nos
  319.     mostrará como ventana PopUp.
  320.  
  321.     Para que se mostrara como ventana estándar sólo habría que haber
  322.     intercalado un asterisco entre las dos barras inclinadas, en vez
  323.     del guión, tal y como haremos en la siguiente llamada, desde la
  324.     ficha Vinos de Jumilla.
  325.  
  326.     - Seguimos, nos posicionamos sobre Vinos tintos.
  327.     Pulsamos Fichas texto.
  328.     El primer campo lo rellenamos con "Vinos de Jumilla".
  329.     El segundo con "¡Qué cuerpo!".
  330.     El Texto con "Son muy buenos, pero como ese /*/Vega
  331.     nosequé**1100// no hay otro".
  332.     Pulsamos Tab.
  333.     Elegimos Ventana.
  334.     Pulsamos Aceptar.
  335.  
  336.     Hemos creado otra Ficha de texto que contiene una llamada a una
  337.     ventana, que se mostrará en forma de ventana estándar, desde la
  338.     frase "Vega nosequé".
  339.  
  340.     Nos saldrá la Ventana del proyecto, y en ella ya tendremos dos
  341.     nuevos registros con el nivel 2:
  342.  
  343.     Vinos de la ribera del Duero, ID 1240.
  344.     Vinos de Jumilla, ID 1260.
  345.  
  346.     Procedemos a salvar el proyecto con el nombre Vinos7, generamos
  347.     los ficheros, salimos de ioHelps y compilamos el proyecto de
  348.     ayuda.
  349.  
  350.  
  351.  
  352.     7.- Reordenar un menú.
  353.     
  354.     El índice general de nuestra ayuda, (podríamos decir el Menú
  355.     Principal de nuestra ayuda) tiene el siguiente orden (todas las
  356.     fichas tienen nivel 1):
  357.  
  358.     - Falsa                 ID 1020
  359.     - Vinos tintos          ID 1040
  360.     - Vinos rosados         ID 1060
  361.     - Vinos blancos         ID 1080
  362.     - La foto de los vinos  ID 1100
  363.  
  364.     Pero ahora deseamos que los vinos blancos aparezcan antes de los
  365.     vinos rosados.
  366.  
  367.     - Nos posicionamos en el registro Vinos rosados.
  368.     Pulsamos el botón Modificar.
  369.     Con el ratón nos posicionamos en el recuadro ID.
  370.     Borramos completamente el número existente y lo sustituimos por el
  371.     número 1090, que es un número que está entre el número ID de los
  372.     Vinos blancos (1080) y el número ID de La foto de los vinos
  373.     (1100).
  374.     Pulsamos sobre Aceptar.
  375.  
  376.     Nuestro registro Vinos rosados se ha desplazado al sitio deseado.
  377.     Pero aún no hemos terminado.
  378.     ¿No habíamos efectuado (en el paso 4 del tutorial) una llamada a
  379.     la ventana de los Vinos rosados desde la ficha Manzanilla?.
  380.     Más bien, sí.
  381.     Pues si no queremos que nos salga un error en el sistema de ayuda,
  382.     deberemos modificar esa llamada.
  383.  
  384.     - Nos posicionaremos en Manzanilla, y mediante el botón modificar,
  385.     cambiaremos el número ID 1060 de la llamada, por el 1090, que es
  386.     el nuevo que le hemos dado a la Ficha de los Vinos Rosados.
  387.  
  388.     ¡Sólo deberemos modificar el número ID de la llamada que está en
  389.     el recuadro del hipertexto, nada más!.
  390.  
  391.     Procedemos a salvar el proyecto con el nombre Vinos9, generamos
  392.     los ficheros, salimos de ioHelps y compilamos el proyecto de
  393.     ayuda
  394.    
  395.  
  396.  
  397.     8.- Finalizar el proyecto de ayuda.
  398.  
  399.     Antes de dar por finalizar el sistema de ayuda, es conveniente
  400.     realizar una serie de tareas:
  401.  
  402.     - Revisar todos y cada uno de los textos introducidos.
  403.     Siempre se cuela alguna falta de ortografía, algún error en los
  404.     textos o las llamadas, etc.
  405.     El que sean culpa del "bug" alienígena, no impide el que haya que
  406.     corregirlos.
  407.  
  408.     - Imprimir todos los listados.
  409.     Su visión nos ayudará bastante a la hora de corregirlo, ampliarlo,
  410.     etc.
  411.  
  412.     - Ver qué le falta.
  413.     Siempre, siempre, se olvida algo.
  414.  
  415.     - Ver qué le sobra.
  416.     Todos tendemos, y yo el que más, a reiterar en exceso las cosas.
  417.     No olvidemos aquello de "Lo bueno si breve..."
  418.  
  419.     - Qué hacer con el registro falso.
  420.     Pues no, no me había olvidado de él.
  421.     Este es el momento de ver si tiene alguna utilidad, como poner
  422.     alguna explicación previa al Indice general de la ayuda, o así...
  423.     Si no le encontramos ninguna, pues nos posicionamos sobre él.
  424.     Pulsamos el botón de Borrar.
  425.     Pulsamos Aceptar.
  426.     ¡¡¡ Y ya hemos terminado !!!.
  427.  
  428.     Procedemos a salvar el proyecto con el nombre VinosFin, generamos
  429.     los ficheros, salimos de ioHelps y compilamos el proyecto de
  430.     ayuda.
  431.  
  432.  
  433.     ¡¡¡Que os sea de utilidad!!!   Saludos,
  434.  
  435.  
  436.                                    Iñaki Otero
  437.                                    c/Sapporo nº 18. Esc. dcha. 2º B
  438.                                    28923 ALCORCON (Madrid)
  439.  
  440.